.TH "fwTime" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
fwTime \- 
.PP
Time management and measurement.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <fwTime.h>\fP
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static double \fBmeasureTimeSecond\fP ()"
.br
.ti -1c
.RI "static double \fBmeasureTimeMs\fP ()"
.br
.ti -1c
.RI "static double \fBmeasureTimeMicros\fP ()"
.br
.ti -1c
.RI "static int \fBwait\fP (double t0, double t)"
.br
.ti -1c
.RI "static void \fBwait\fP (double t)"
.br
.ti -1c
.RI "static double \fBmeasureTimeSecond\fP ()"
.br
.ti -1c
.RI "static double \fBmeasureTimeMs\fP ()"
.br
.ti -1c
.RI "static double \fBmeasureTimeMicros\fP ()"
.br
.ti -1c
.RI "static int \fBwait\fP (double t0, double t)"
.br
.ti -1c
.RI "static void \fBwait\fP (double t)"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static double \fBminTimeForUsleepCall\fP = 4"
.br
.in -1c
.SH "Detailed Description"
.PP 
Time management and measurement. 
.SH "Member Function Documentation"
.PP 
.SS "double fwTime::measureTimeMicros ()\fC [static]\fP"Return the time in microseconds.
.PP
\fBSee also:\fP
.RS 4
\fBmeasureTimeMs()\fP, \fBmeasureTimeSecond()\fP 
.RE
.PP

.SS "double fwTime::measureTimeMs ()\fC [static]\fP"This time is in milli-seconds. Threshold to activate usleep() in waiting methods (see \fBwait()\fP). This threshold is needed, because usleep() is not accurate on many machines. Call sleep() functions during the time to wait minus fwTime::minTimeForUsleepCall. The rest of the time to wait is managed by a while loop.
.PP
Return the time in milliseconds.
.PP
\fBSee also:\fP
.RS 4
\fBmeasureTimeMicros()\fP, \fBmeasureTimeSecond()\fP 
.RE
.PP

.SS "double fwTime::measureTimeSecond ()\fC [static]\fP"Return the measured time in seconds.
.PP
\fBSee also:\fP
.RS 4
\fBmeasureTimeMs()\fP 
.RE
.PP

.SS "void fwTime::wait (double t)\fC [static]\fP"Wait t miliseconds from now.
.PP
The waiting is done by a call to usleep() if the time to wait is greater than fwTime::minTimeForUsleepCall.
.PP
\fBParameters:\fP
.RS 4
\fIt\fP : Time to wait in ms. 
.RE
.PP

.SS "int fwTime::wait (double t0, double t)\fC [static]\fP"Wait t miliseconds after t0 (in ms).
.PP
The waiting is done by a call to usleep() if the time to wait is greater than fwTime::minTimeForUsleepCall.
.PP
\fBParameters:\fP
.RS 4
\fIt0\fP : reference time (in ms) 
.br
\fIt\fP : time to wait (in ms)
.RE
.PP
\fBReturns:\fP
.RS 4
0 : The function did wait. 
.PP
1 : The time was already over, no need to wait. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
